Fix/improve config no_auto_register_paths docs #285
Conversation
I wrote it the other way to prioritize which are core Hanami concepts, but I think it's better to be accurate
| Note that the default value for `no_auto_register_paths` is `["db", "entities", "relations", "structs"]`, | ||
| so you do not need to specify those. Also, be sure to append to that list. | ||
|
|
||
| These apply for the root of the application, as well within any slices. |
There was a problem hiding this comment.
I think we should link to the "slices" guide here. If a reader is going through the docs in rough order of appearance, they won't have got to slices yet.
There was a problem hiding this comment.
Good call, added!
This makes me think we should consider re-ordering the guides, as well (perhaps on the new site). The current order is: Booting, Container and components, Providers, Settings, Autoloading, Environments, App config, Inflector, Code reloading, Slices.
Slices are more core than code reloading, or the inflector IMO. I think Autoloading and Environments could be lower as well. Perhaps: Booting, Container and components, Providers, Settings, App config, Slices, Autoloading, Environments, Inflector, Code reloading?
I still think linking to Slices is a good idea regardless of the order.
There was a problem hiding this comment.
Thanks @cllns :) Agree that it'd be worth trying a different order. We came up with this order years ago for 2.0 and haven't reconsidered it since. I think an "Overview" page for the App guide would be useful thing to have too. That way we can introduce all the key concepts in relation to each other, and provide relevant jumping off links to learn more.
timriley
left a comment
timriley
left a comment
There was a problem hiding this comment.
Looks good. Thanks! One minor suggestion, otherwise happy to see this go in.
|
Updated the guides for 2.0 and 2.1 as well, but listing the no_auto_register_paths as just |
|
@cllns reminder that this is approved and ready to merge when you're happy - though it'll need to be extended to 2.3 as well now? |
Will extend to 2.0 and 2.1 once this review gets approved.